<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
<link rel="STYLESHEET" href="lib.css" type='text/css' />
<link rel="SHORTCUT ICON" href="../icons/pyfav.png" type="image/png" />
<link rel='start' href='../index.html' title='Python documentation Index' />
<link rel="first" href="lib.html" title='Python library Reference' />
<link rel='contents' href='contents.html' title="Contents" />
<link rel='index' href='genindex.html' title='Index' />
<link rel='last' href='about.html' title='About this document...' />
<link rel='help' href='about.html' title='About this document...' />
<link rel="next" href="cookie-example.html" />
<link rel="prev" href="cookie-objects.html" />
<link rel="parent" href="module-Cookie.html" />
<link rel="next" href="cookie-example.html" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name='aesop' content='information' />
<title>18.23.2 Morsel Objects </title>
</head>
<body>
<div class="navigation">
<div id='top-navigation-panel' xml:id='top-navigation-panel'>
<table align="center" width="100%" cellpadding="0" cellspacing="2">
<tr>
<td class='online-navigation'><a rel="prev" title="18.23.1 cookie Objects"
  href="cookie-objects.html"><img src='../icons/previous.png'
  border='0' height='32'  alt='Previous Page' width='32' /></a></td>
<td class='online-navigation'><a rel="parent" title="18.23 cookie  "
  href="module-Cookie.html"><img src='../icons/up.png'
  border='0' height='32'  alt='Up one Level' width='32' /></a></td>
<td class='online-navigation'><a rel="next" title="18.23.3 Example"
  href="cookie-example.html"><img src='../icons/next.png'
  border='0' height='32'  alt='Next Page' width='32' /></a></td>
<td align="center" width="100%">Python Library Reference</td>
<td class='online-navigation'><a rel="contents" title="Table of Contents"
  href="contents.html"><img src='../icons/contents.png'
  border='0' height='32'  alt='Contents' width='32' /></a></td>
<td class='online-navigation'><a href="modindex.html" title="Module Index"><img src='../icons/modules.png'
  border='0' height='32'  alt='Module Index' width='32' /></a></td>
<td class='online-navigation'><a rel="index" title="Index"
  href="genindex.html"><img src='../icons/index.png'
  border='0' height='32'  alt='Index' width='32' /></a></td>
</tr></table>
<div class='online-navigation'>
<b class="navlabel">Previous:</b>
<a class="sectref" rel="prev" href="cookie-objects.html">18.23.1 Cookie Objects</a>
<b class="navlabel">Up:</b>
<a class="sectref" rel="parent" href="module-Cookie.html">18.23 Cookie  </a>
<b class="navlabel">Next:</b>
<a class="sectref" rel="next" href="cookie-example.html">18.23.3 Example</a>
</div>
<hr /></div>
</div>
<!--End of Navigation Panel-->

<h2><a name="SECTION00202320000000000000000"></a><a name="morsel-objects"></a>
<br>
18.23.2 Morsel Objects 
</h2>

<p>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><span class="typelabel">class</span>&nbsp;<tt id='l2h-4434' xml:id='l2h-4434' class="class">Morsel</tt></b>(</nobr></td>
  <td><var></var>)</td></tr></table></dt>
<dd>
Abstract a key/value pair, which has some <a class="rfc" id='rfcref-103464' xml:id='rfcref-103464'
href="http://www.faqs.org/rfcs/rfc2109.html">RFC 2109</a> attributes.

<p>
Morsels are dictionary-like objects, whose set of keys is constant --
the valid <a class="rfc" id='rfcref-103466' xml:id='rfcref-103466'
href="http://www.faqs.org/rfcs/rfc2109.html">RFC 2109</a> attributes, which are

<p>

<ul>
<li><code>expires</code>
</li>
<li><code>path</code>
</li>
<li><code>comment</code>
</li>
<li><code>domain</code>
</li>
<li><code>max-age</code>
</li>
<li><code>secure</code>
</li>
<li><code>version</code>
</li>
</ul>

<p>
The keys are case-insensitive.
</dl>

<p>
<dl><dt><b><tt id='l2h-4435' xml:id='l2h-4435' class="member">value</tt></b></dt>
<dd>
The value of the cookie.
</dl>

<p>
<dl><dt><b><tt id='l2h-4436' xml:id='l2h-4436' class="member">coded_value</tt></b></dt>
<dd>
The encoded value of the cookie -- this is what should be sent.
</dl>

<p>
<dl><dt><b><tt id='l2h-4437' xml:id='l2h-4437' class="member">key</tt></b></dt>
<dd>
The name of the cookie.
</dl>

<p>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-4438' xml:id='l2h-4438' class="method">set</tt></b>(</nobr></td>
  <td><var>key, value, coded_value</var>)</td></tr></table></dt>
<dd>
Set the <var>key</var>, <var>value</var> and <var>coded_value</var> members.
</dl>

<p>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-4439' xml:id='l2h-4439' class="method">isReservedKey</tt></b>(</nobr></td>
  <td><var>K</var>)</td></tr></table></dt>
<dd>
Whether <var>K</var> is a member of the set of keys of a <tt class="class">Morsel</tt>.
</dl>

<p>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-4440' xml:id='l2h-4440' class="method">output</tt></b>(</nobr></td>
  <td><var></var><big>[</big><var>attrs</var><big>[</big><var>, header</var><big>]</big><var></var><big>]</big><var></var>)</td></tr></table></dt>
<dd>
Return a string representation of the Morsel, suitable
to be sent as an HTTP header. By default, all the attributes are included,
unless <var>attrs</var> is given, in which case it should be a list of attributes
to use. <var>header</var> is by default <code>"Set-Cookie:"</code>.
</dl>

<p>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-4441' xml:id='l2h-4441' class="method">js_output</tt></b>(</nobr></td>
  <td><var></var><big>[</big><var>attrs</var><big>]</big><var></var>)</td></tr></table></dt>
<dd>
Return an embeddable JavaScript snippet, which, if run on a browser which
supports JavaScript, will act the same as if the HTTP header was sent.

<p>
The meaning for <var>attrs</var> is the same as in <tt class="method">output()</tt>.
</dl>

<p>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-4442' xml:id='l2h-4442' class="method">OutputString</tt></b>(</nobr></td>
  <td><var></var><big>[</big><var>attrs</var><big>]</big><var></var>)</td></tr></table></dt>
<dd>
Return a string representing the Morsel, without any surrounding HTTP
or JavaScript.

<p>
The meaning for <var>attrs</var> is the same as in <tt class="method">output()</tt>.
</dl>

<p>

<div class="navigation">
<div class='online-navigation'>
<p></p><hr />
<table align="center" width="100%" cellpadding="0" cellspacing="2">
<tr>
<td class='online-navigation'><a rel="prev" title="18.23.1 cookie Objects"
  href="cookie-objects.html"><img src='../icons/previous.png'
  border='0' height='32'  alt='Previous Page' width='32' /></a></td>
<td class='online-navigation'><a rel="parent" title="18.23 cookie  "
  href="module-Cookie.html"><img src='../icons/up.png'
  border='0' height='32'  alt='Up one Level' width='32' /></a></td>
<td class='online-navigation'><a rel="next" title="18.23.3 Example"
  href="cookie-example.html"><img src='../icons/next.png'
  border='0' height='32'  alt='Next Page' width='32' /></a></td>
<td align="center" width="100%">Python Library Reference</td>
<td class='online-navigation'><a rel="contents" title="Table of Contents"
  href="contents.html"><img src='../icons/contents.png'
  border='0' height='32'  alt='Contents' width='32' /></a></td>
<td class='online-navigation'><a href="modindex.html" title="Module Index"><img src='../icons/modules.png'
  border='0' height='32'  alt='Module Index' width='32' /></a></td>
<td class='online-navigation'><a rel="index" title="Index"
  href="genindex.html"><img src='../icons/index.png'
  border='0' height='32'  alt='Index' width='32' /></a></td>
</tr></table>
<div class='online-navigation'>
<b class="navlabel">Previous:</b>
<a class="sectref" rel="prev" href="cookie-objects.html">18.23.1 Cookie Objects</a>
<b class="navlabel">Up:</b>
<a class="sectref" rel="parent" href="module-Cookie.html">18.23 Cookie  </a>
<b class="navlabel">Next:</b>
<a class="sectref" rel="next" href="cookie-example.html">18.23.3 Example</a>
</div>
</div>
<hr />
<span class="release-info">Release 2.5.1, documentation updated on 18th April, 2007.</span>
</div>
<!--End of Navigation Panel-->
<address>
See <i><a href="about.html">About this document...</a></i> for information on suggesting changes.
</address>
</body>
</html>
